/*
 SGRecyclableType.h
 Date Created: March 6, 2010
 
 Authors: Karanvir Gill <viper1029@gmail.com>
          Frank Lau <flaua@sfu.ca>
 
 Copyright (C) 2010 Green-Power
 
 URL: http://code.google.com/p/green-power
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 3 of the License, or
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
 $Id$
 */

#import <Foundation/Foundation.h>

/**
 * This class contains information about a recyclable type
 */
@interface SGRecyclableType : NSObject {
	NSString *uniqueName;
	NSString *name;
	NSString *image;
	NSUInteger depositValue;
  NSString *description;
}

@property (nonatomic,retain) NSString *uniqueName;
@property (nonatomic,retain) NSString *name;
@property (nonatomic,retain) NSString *description;
@property (nonatomic,retain) NSString *image;
@property (nonatomic) NSUInteger depositValue;


/**
 * Two types are equal if their unique names are equal.
 * If the object being compared to is no an SGRecyclableType, then 
 * NSObject#isEqual: is used.
 *
 * \param anObject The second object to compare this against
 *
 * \return YES if they are equal
 */
- (BOOL)isEqual:(id)anObject;

/**
 * \returns an array of SGRecyclableType containing all recyclable types
 * supported by the sorting game
 */
+ (NSArray *)listOfficialTypes;

@end
